'\" t
.\"     Title: Ceph RADOS Mutex
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 03/09/2023
.\"    Manual: CTDB - clustered TDB database
.\"    Source: ctdb
.\"  Language: English
.\"
.TH "CEPH RADOS MUTEX" "7" "03/09/2023" "ctdb" "CTDB \- clustered TDB database"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ctdb_mutex_ceph_rados_helper \- Ceph RADOS cluster mutex helper
.SH "DESCRIPTION"
.PP
ctdb_mutex_ceph_rados_helper can be used as a cluster lock provider for CTDB\&. When configured, split brain avoidance during CTDB recovery will be handled using locks against an object located in a Ceph RADOS pool\&. To enable this functionality, include the following line in the
[cluster]
section of
\fBctdb.conf\fR(5):
.sp
.if n \{\
.RS 4
.\}
.nf
cluster lock = !ctdb_mutex_ceph_rados_helper [Cluster] [User] [Pool] [Object]

Cluster: Ceph cluster name (e\&.g\&. ceph)
User: Ceph cluster user name (e\&.g\&. client\&.admin)
Pool: Ceph RADOS pool name
Object: Ceph RADOS object name
    
.fi
.if n \{\
.RE
.\}
.PP
The Ceph cluster
\fICluster\fR
must be up and running, with a configuration, and keyring file for
\fIUser\fR
located in a librados default search path (e\&.g\&. /etc/ceph/)\&.
\fIPool\fR
must already exist\&.
.PP
For informational purposes, ctdb_mutex_ceph_rados_helper will also register the cluster lock holder in Ceph Manager\*(Aqs service map\&.
.SH "SEE ALSO"
.PP
\fBctdb\fR(7),
\fBctdbd\fR(1),
\m[blue]\fB\%http://ctdb.samba.org/\fR\m[]
.SH "AUTHOR"
.br
.PP
This documentation was written by David Disseldorp
.SH "COPYRIGHT"
.br
Copyright \(co 2016 David Disseldorp
.br
.PP
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version\&.
.PP
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&. See the GNU General Public License for more details\&.
.PP
You should have received a copy of the GNU General Public License along with this program; if not, see
\m[blue]\fB\%http://www.gnu.org/licenses\fR\m[]\&.
.sp
